home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
maximus
/
lcall12.zip
/
LOGCALL.DOC
< prev
next >
Wrap
Text File
|
1992-08-01
|
8KB
|
230 lines
******************************************************************
LOGCALL Version 1.1
August 1, 1992
MAXIMUS TODAY'S CALLER LISTER
Code by Evan Siegworth
Docs by Ed Baldwin &
Evan Siegworth
USER MANUAL
Copyright (c) 1992 Evan Siegworth
*******************************************************************
THE LEGAL BUSINESS
------------------
LOGCALL operates as specified on the authors' and beta testers'
systems. Use it at your own risk. No warranty is stated or
implied. The author shall not be responsible for any damages
resulting from its' use, directly or indirectly.
LOGCALL is distributed as a Freely Available Copyrighted Program.
You may use, copy, or lose it, but I own the rights to it.
SysOps may use any compression method acceptable to them for file
storage on their respective BBS's. The author asks only that BBS
advertisements NOT be included in the archive or archive comments.
No fee may be charged for distribution.
While LOGCALL is freely available for use in non-commercial
environments, donations to the author will always be gratefully
accepted.
For information of donations, use on a commercial bbs, or info on
where to send suggestions, please read the REGIST.DOC included
in the archive.
LOGCALL will be supported in the MUFFIN Echo, any questions will be
promptly answered.
THE DISTRIBUTION ARCHIVE (LCALL11.ZIP)
---------------------------------------
This archive should contain the following files:
LOGCALL.DOC - The complete program documentation.
LOGCALL.EXE - The Executable Program.
LOGCALL.CTL - The Configuration File.
HISTORY.DOC - The program history.
README.OS2 - Information for OS/2 Users.
REGIST.DOC - Donation/Registration Information.
WHAT DOES IT DO
---------------
LOGCALL is a Maximus CBCS Today's Callers List Creation utility which
can create a list of the users whom have called today and a list of
the last few callers. It is very configurable. You set up how you
want the utility to display the information.
It creates .BBS files that can be directly displayed to the user.
INSTALLING LOGCALL
------------------
1. Edit the LOGCALL.CTL file to your systems configuration. An
explanation of this is provided in a later section.
DONT FORGET!
2. Compile the control file. This is done by entering LOGCALL /U
at a DOS prompt in the directory that you have both LOGCALL.EXE and
LOGCALL.CTL located in. This will create logcall.cfg.
3. That's about it! Test it's functionality.
CONFIGURATION FILE
------------------
** The Configuration File (logcall.cfg) is created by compiling
the Control file (logcall.ctl).
You compile by running LogCall with the '/u' option.
Most of the Control file is self-explanatory.
Some notes:
-When specifing filenames, paths are not needed if you want
the file to be created in the current directory.
If you want to specify a different directory, you must
type in the FULL path including drive letter.
-If you make a change, be sure to re-compile
-Each section must end with the 'End' statement.
** The 'CustomDisplayLine' section is the most complicated section so I
am covering its explanation here.
This is also the most unique feature of this program. YOU control
how the program displays its information.
Each display line must be proceeded by its name.
Entering the display line is alot like entering a line in a MECCA file.
Straight text will be copied directly. And there are several
informational tokens that can be placed on the line, as well as
all the regular color tokens. At this time, however, background
colors and blinking are not supported.
For Example:
A display line like this:
User # 23 Evan Siegworth calling from Channelview, TX
Would be entered like this:
#TEST
#User # [user] [name] calling from [city]
Its that simple!
You can spice it up by adding color tokens.
To then use this in your Todays Callers List, you add the line
StatLine TEST
to the 'TodaysCallers' section in the control file.
The Header lines are similar, however, they do not use any of the info
tokens. The header line is displayed at the beginning of the file.
Example Usage:
(in appropriate section)
Header TEST2
(in CustomDisplayLine section)
#TEST2
#<-----------------------TODAYS CALLERS------------------------>
** Some important notes:
Only ONE token per bracket. [user green name city] will NOT work.
Your display line MUST be the next line after its name header.
Several display lines are included in the .ctl that came with
the program. Use them or create your own.
You can use ORACLE to test your display lines.
** AVAILABLE TOKENS:
MAXIMUS Colour Tokens
[START] - Logon Time
[END] - Logoff Time
[DATE] - Logon Date
[NAME] - User's Real Name
[ALIAS] - User's Handle/Alias
[CITY] - User's City/State
[BAUD] - User's Baud Rate(displays LOCAL for local calls)
[TOTAL] - Total Number of Calls
[TIME] - Minutes Spent Online
[USER] - User Number(field length is 3 spaces)
USING LOGCALL
-------------
** LogCall is run in your batch file that starts the bbs
with the command...
LOGCALL %1 %2
%1 being the name/path of the Lastuser.bbs file.
%2 being the name/path of the Max log file
For Example:
LOGCALL C:\MAX\LASTUSER.BBS C:\MAX\MAX.LOG
You should only run it after an errorlevel 5 exit.
During its operation LogCall will check the Lastuser.bbs to see
if its newer the last time it was run. This prevents it from
running after a dropped carrier and other situations where there
really wasnt a caller.
You can, however, disable this option with the '/t' option.
LOGCALL /T LASTUSER.BBS MAX.LOG
This is primarly useful when testing your Display Lines.
** You should delete the today's callers list (ex: Callers.bbs)
every night. Put it in your nightly maintance.
** Next add a command to your MAXIMUS MENUS.CTL file:
(using Callers.bbs from above sample .ctl file. substitute own
name of course)
Display_File Misc\Callers Twit "Todays Callers"
** If you wish to utilize the Last Few Callers feature.
Add a [LINK] command to your WELCOME.BBS or other file that you
wish to display to the users at logon to show the last few callers.
[LINK]C:\MAX\MISC\CALLS
THANKS...(as of yet)
---------
Thanks to Scott Dudley for his excellent BBS System!
to Ed Baldwin for his help with code development, testing and DOC
writing.
to Gary Seid for his numerous bug reports! :)
and to ALL who are patiently waiting through the bug-fix releases.
CREDITS
-------
BORLAND C++ ... Copyrighted by Borland International, Inc.
ORACLE &
MAXIMUS CBCS ... Copyrighted by Scott Dudley
LOGCALL ... Copyrighted by Evan Siegworth